Список тарифов

Запрос позволяет получить информацию обо всех доступных тарифах.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/class? 
limit=<количество записей>
&skip=<количество пропускаемых записей>
&sorting_field=<поле для сортировки>
&sorting_direction=<направление сортировки>

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Запрос может содержать следующие необязательные аргументы:

  • limit — количество выводимых записей. При отсутствии данного параметра возвращается информация о первых 100 записях.

  • skip — количество пропускаемых записей. При отсутствии данного параметра возвращается информация начиная с первой записи.

  • sorting_field — имя поля, по которому будет производиться сортировка.

  • sorting_direction — направление сортировки. Допустимы следующие значения:

    • 1 — сортировка по возрастанию.
    • -1 — сортировка по убыванию.
  • lat — широта. Параметр используется для указания региона, тарифы которого были запрошены.

  • lon — долгота. Параметр используется для указания региона, тарифы которого были запрошены.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
items Список тарифов. Массив
_id Идентификатор тарифа. Строка
name Название тарифа. Строка
amount Количество найденных записей. Число
sorting_direction Направление сортировки. Возможные значения:
- 1 — сортировка по возрастанию.
- -1 — сортировка по убыванию.
Число
sorting_field Поле, по которому проводилась сортировка. Строка

Пример запроса

GET https://business.taxi.yandex.ru/api/1.0/class?lat=55.76&lon=37.65
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "items": [
    {
      "_id": "vip",
      "name": "Бизнес"
    },
    {
      "_id": "business",
      "name": "Комфорт"
    },
    {
      "_id": "comfortplus",
      "name": "Комфорт+"
    },
    {
      "_id": "minivan",
      "name": "Минивэн"
    },
    {
      "_id": "econom",
      "name": "Эконом"
    }
  ],
  "amount": 5,
  "sorting_direction": 1,
  "sorting_field": "name"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 401 — был передан неверный OAuth-токен.
  • 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
  • 403 — у клиента не хватает прав на выполнение данного запроса.